<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>[Generic Component Framework v3] GCF::LogMessageHandlerInterface Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<!--link href="tabs.css" rel="stylesheet" type="text/css"-->
</head><body>
 <div id="wrapper">
    <div id="logo_box">
        <a class="img_link" href="https://github.com/pnudupa/gcf" target="_blank" ><img style="float:left;margin-left:10px;margin-top:5px;margin-bottom:5px;"src="header_gcf_logo.jpg" alt="GCF LOGO"/></a>
        <a class="img_link" href="https://www.vcreatelogic.com/" target="_blank" ><img style="float:right;margin-right:10px; margin-top: 30px;" src="header_vcl_logo.jpg" alt="VCL LOGO"/></a>
        <div style="clear:both"></div>
    </div>
    <div class="nav">
        <ul>
            <li class="selectedpage">
                <a class="a-home" href="index.html" >
                    <span>Home</span>
                </a>
            </li>
            <li>
                <a class="a-classes " href="classes.html">
                    <span>All Classes</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_modules.html">
                    <span>Modules</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_guides_and_videos.html">
                    <span>Guides & Videos</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_tools_and_inbuilt_components.html">
                    <span>Tools & Components</span>
                </a>
            </li>
        </ul>
    </div>
    <div id="main-content">
        <div class="inside">
        <div>
<!-- Generated by Doxygen 1.8.16 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>GCF</b></li><li class="navelem"><a class="el" href="class_g_c_f_1_1_log_message_handler_interface.html">LogMessageHandlerInterface</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_g_c_f_1_1_log_message_handler_interface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">GCF::LogMessageHandlerInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__gcf__core.html">GCF Core Module</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This interface is used to represent the class that can do the actual logging.  
 <a href="class_g_c_f_1_1_log_message_handler_interface.html#details">More...</a></p>

<p><code>#include &lt;GCF3/Log&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a732f05e31e9d76e711089a0b0bd70f3a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_log_message_handler_interface.html#a732f05e31e9d76e711089a0b0bd70f3a">handleLogMessage</a> (<a class="el" href="class_g_c_f_1_1_log_message.html">GCF::LogMessage</a> *msg)=0</td></tr>
<tr class="separator:a732f05e31e9d76e711089a0b0bd70f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8553b478a54555ced6cc948a8e65feb"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_log_message_handler_interface.html#aa8553b478a54555ced6cc948a8e65feb">print</a> (<a class="el" href="class_g_c_f_1_1_log_message.html">GCF::LogMessage</a> *msg, QTextStream &amp;ts)=0</td></tr>
<tr class="separator:aa8553b478a54555ced6cc948a8e65feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08649910925fda561e106c974fa02787"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_log_message_handler_interface.html#a08649910925fda561e106c974fa02787">toSupport</a> (const QString &amp;msg)</td></tr>
<tr class="separator:a08649910925fda561e106c974fa02787"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecab4149153893b3a5f75042862f07c0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_log_message_handler_interface.html#aecab4149153893b3a5f75042862f07c0">toClipboard</a> (const QString &amp;msg)</td></tr>
<tr class="separator:aecab4149153893b3a5f75042862f07c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba222654e8c8840a4786744770e5d295"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_log_message_handler_interface.html#aba222654e8c8840a4786744770e5d295">flush</a> ()</td></tr>
<tr class="separator:aba222654e8c8840a4786744770e5d295"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that implements this interface can decide the way in which the application logs the different log messages generated in the application via the <a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> mechanism. By default <a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> implements this interface and logs the messages to an appropriate log file. <br  />
 You can implement this interface in a class and register it with <a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> as the message handler for the application, to control the way in which messages are logged. For example you could write a LogMessageHandler that would write these log messages on to another application via sockets, where the actual logging happens. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a732f05e31e9d76e711089a0b0bd70f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a732f05e31e9d76e711089a0b0bd70f3a">&#9670;&nbsp;</a></span>handleLogMessage()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::LogMessageHandlerInterface::handleLogMessage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_log_message.html">GCF::LogMessage</a> *&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> would call this function of the handler with the reported message so that the handler can log it appropriately. </p>

<p>Implemented in <a class="el" href="class_g_c_f_1_1_log.html#a77c31c23e903ee4dd89eac3fa239f0c8">GCF::Log</a>.</p>

</div>
</div>
<a id="aa8553b478a54555ced6cc948a8e65feb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8553b478a54555ced6cc948a8e65feb">&#9670;&nbsp;</a></span>print()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::LogMessageHandlerInterface::print </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_log_message.html">GCF::LogMessage</a> *&#160;</td>
          <td class="paramname"><em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QTextStream &amp;&#160;</td>
          <td class="paramname"><em>ts</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> would call this function of the handler with the reported message so that the handler can stream the log in appropriate print format to the text stream passed. </p>

<p>Implemented in <a class="el" href="class_g_c_f_1_1_log.html#a3dc939a33f037d3c19765033d7f48670">GCF::Log</a>.</p>

</div>
</div>
<a id="a08649910925fda561e106c974fa02787"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08649910925fda561e106c974fa02787">&#9670;&nbsp;</a></span>toSupport()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::LogMessageHandlerInterface::toSupport </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> would call this function of the handler with the reported message so that the handler can report the <code>msg</code> to support. </p>

</div>
</div>
<a id="aecab4149153893b3a5f75042862f07c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecab4149153893b3a5f75042862f07c0">&#9670;&nbsp;</a></span>toClipboard()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::LogMessageHandlerInterface::toClipboard </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> would call this function of the handler with the reported message so that the handler can dump <code>msg</code> to clipboard. </p>

</div>
</div>
<a id="aba222654e8c8840a4786744770e5d295"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba222654e8c8840a4786744770e5d295">&#9670;&nbsp;</a></span>flush()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::LogMessageHandlerInterface::flush </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_g_c_f_1_1_log.html">GCF::Log</a> would call this function of the handler with the reported message so that the handler can perform a flush operation. </p>

</div>
</div>
</div><!-- contents -->
</div>
</div>
</div>
<div class="footer_content">
<table width="100%" class="footer">
<tr>
<td align="left" width="50%">Copyright &copy; 2013-2019,
 <a class="el" href="http://www.vcreatelogic.com" target="_black">VCreate Logic Private Limited</a></td>
<td align="right" width="50%"><a class="el" href="http://www.vcreatelogic.com/products/gcf" target="_black">GCF - Generic Component Framework</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
